![]() | IBM Endpoint Manager Inspectors Reference |
Win: Windows
Lin: Red Hat and SUSE Linux
Sol: SUN Solaris
HPUX: Hewlett-Packard UNIX version
AIX: IBM AIX
Mac: Apple Macintosh
Ubu: Ubuntu/Debian
WM: Windows Mobile
The version (e.g. Lin:8.1) corresponds to the version of the IEM product (8.1) in which the inspector was introduced in the client on that platform.
The version number is not shown if it is less than 8.0.
These Inspectors retrieve information about the application containing the relevance evaluator.
Declaration | Description | Platforms (?) |
client | Returns the client object corresponding to the BigFix application evaluating the current relevance expression. This is equivalent to the file system object of the BigFix Client executable. Example: pathname of parent folder of client - Returns the pathname corresponding to the folder containing the BigFix Client executable. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Declaration | Return type | Description | Platforms (?) |
authenticating of <client> | <boolean> Plural: authenticatings | Returns true when client is performing client authentication to the relay | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
certificate of <client> | <boolean> Plural: certificates | Returns true when the client has received its certificate from the server | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
data folder of <client> | <folder> Plural: data folders | Returns the __BESData folder | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
administrator <string> of <client> | <setting> Plural: administrators | If the administrator named in the <string> is enabled on the given <client> computer, this property returns a setting with the given name and the value 'allow.' For instance, if the name of the administrator is joe_admin, then the client would return a setting object with the name 'joe_admin' and a value of 'allow'. Casting this as a string would return 'joe_admin=allow'. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
administrator of <client> | <setting> Plural: administrators | Returns one or more settings each representing an administrator of the client. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
brand of <client> | <string> Plural: brands | Returns the branding ID of a client computer. BigFix is the norm, but there are other brands that use the technology, including Trend Micro. | Win:8.1, Lin:8.1, Sol:8.1, HPUX:8.1, AIX:8.1, Mac:8.1, Ubu:8.1 |
build target of <client> | <string> Plural: build targets | Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2 | |
evaluationcycle of <client> | <evaluation cycle> Plural: evaluationcycles | Returns an object corresponding to the time it takes to evaluate the content set on the specified BigFix Client. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
last command time of <client> | <time> Plural: last command times | Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2 | |
registration address of <client> | <ipv4or6 address> Plural: registration addresses | This Inspector returns the IP address (as an <ipv4or6 address> type) that the specified BigFix client registered with. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
registration cidr address of <client> | <string> Plural: registration cidr addresses | This Inspector returns the cidr address from the adapter that the specified BigFix client registered with. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
registration mac address of <client> | <string> Plural: registration mac addresses | This Inspector returns the MAC address that the specified BigFix client registered with. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
registration subnet address of <client> | <ipv4or6 address> Plural: registration subnet addresses | This Inspector returns the subnet address (as an <ipv4or6 address> type) from the adapter that the specified BigFix client registered with. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
setting <string> of <client> | <setting> Plural: settings | Returns a client setting whose name matches the string provided from the client settings. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
setting of <client> | <setting> Plural: settings | Returns one or more settings from the client settings. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
upload progress of <client> | <string> Plural: upload progresses | Returns a status message string indicating No Progress, Errors or a string like the following to indicate the upload progress:<filename>: x of <filesize> bytes in <number> seconds. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
version of <client> | <version> Plural: versions | The product version of the BES application (BESClient or QnA).Note: On the Macintosh only, this Inspector returns a <string>. | Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
Declaration | Description | Platforms (?) |
setting <string> of <site> | Returns the setting whose name matches the string provided from the Fixlet site settings. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
setting of <site> | Returns one or more settings from the site settings. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
administrator <string> of <client> | If the administrator named in the <string> is enabled on the given <client> computer, this property returns a setting with the given name and the value 'allow.' For instance, if the name of the administrator is joe_admin, then the client would return a setting object with the name 'joe_admin' and a value of 'allow'. Casting this as a string would return 'joe_admin=allow'. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
administrator of <client> | Returns one or more settings each representing an administrator of the client. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
setting <string> of <client> | Returns a client setting whose name matches the string provided from the client settings. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
setting of <client> | Returns one or more settings from the client settings. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Declaration | Return type | Description | Platforms (?) |
<setting> as string | <string> | Returns a string formatted as <name>=<value> for the setting. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
effective date of <setting> | <time> Plural: effective dates | Returns the date when the setting was last modified. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
enabled of <setting> | <boolean> Plural: enableds | Returns TRUE if the specified setting is enabled. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
name of <setting> | <string> Plural: names | Returns the name of the setting. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
value of <setting> | <string> Plural: values | Returns the value of the setting. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Declaration | Description | Platforms (?) |
selected server | The BES Server or BES Relay to which the agent reports. Returned as the "selected server" type. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Declaration | Return type | Description | Platforms (?) |
competition size of <selected server> | <integer> Plural: competition sizes | The number of servers in the competition from which this server was selected. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
competition weight of <selected server> | <integer> Plural: competition weights | The total of the weights of the servers in the competition from which this server was selected. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
distance of <selected server> | <integer range> Plural: distances | The distance, in IP gateway hops, to the server. Among servers with the same priority, closer servers are preferred. Returns an integer range, since the exact distance may not be known. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
full gateway address of <selected server> | <ipv4or6 address> Plural: full gateway addresses | During relay selection, a traceroute-like list of the hops between the client and its relay (the selected server) is recorded. That list is accessible through this Inspector. Unlike the 'gateway address' Inspector, this Inspector includes hops that don't reply as 0.0.0.0. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
gateway address <integer> of <selected server> | <ipv4or6 address> Plural: gateway addresses | During relay selection, a traceroute-like list of the hops between the client and its relay (the selected server) is recorded. The elements of that list is accessible through this Inspector.Prior to version 8.0, this inspector returned an <ipv4 address> type. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
gateway address of <selected server> | <ipv4or6 address> Plural: gateway addresses | During relay selection, a traceroute-like list of the hops between the client and its relay (the selected server) is recorded. That list is accessible through this Inspector. However, this Inspector ignores hops that don't reply. If you need the full list, use the 'full gateway address' Inspector.Prior to version 8.0, this inspector returned an <ipv4 address> type. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
ip address of <selected server> | <ipv4or6 address> Plural: ip addresses | The ipv4or6 address to which reports are sent.Prior to version 8.0, this inspector returned an <ipv4 address> type. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
name of <selected server> | <string> Plural: names | The DNS name of the server, if known. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
port number of <selected server> | <integer> Plural: port numbers | The port number to which reports are sent. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
priority of <selected server> | <integer> Plural: priorities | The priority assigned to the server by the BES console. Servers with low priorities are preferred to servers with high priority. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
weight of <selected server> | <integer> Plural: weights | The weight assigned to the server by the BES console. Servers with the same priority and approximate distance compete to be chosen; servers with higher weights are more likely to be chosen. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Declaration | Description | Platforms (?) |
Declaration | Return type | Description | Platforms (?) |
Declaration | Description | Platforms (?) |
current relay | Returns an object corresponding to the server or relay that the client last registered with. This may be a BES Relay or the BES root server. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Declaration | Return type | Description | Platforms (?) |
version of <current relay> | <version> Plural: versions | Returns a version object that is the version of the server that the client last registered with. This may be a BES Relay or the BES root server. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Declaration | Description | Platforms (?) |
root server | Returns an object representing the root BES Server to which the client last registered. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Declaration | Return type | Description | Platforms (?) |
host name of <root server> | <string> Plural: host names | The host (DNS) name of the BES root server that the BES Client last registered with. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
id of <root server> | <integer> Plural: ids | The DSA Server ID of the BES root server that the BES Client last registered with. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Declaration | Description | Platforms (?) |
evaluationcycle of <client> | Returns an object corresponding to the time it takes to evaluate the content set on the specified BigFix Client. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
Declaration | Return type | Description | Platforms (?) |
action duration of <evaluation cycle> | <time interval> Plural: action durations | Time taken performing action processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
action percent of <evaluation cycle> | <floating point> Plural: action percents | Percentage of total time taken performing action processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
api duration of <evaluation cycle> | <time interval> Plural: api durations | Time taken performing client api processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
api percent of <evaluation cycle> | <floating point> Plural: api percents | Percentage of total time taken performing client api processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
archive duration of <evaluation cycle> | <time interval> Plural: archive durations | Time taken performing archive processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
archive percent of <evaluation cycle> | <floating point> Plural: archive percents | Percentage of total time taken performing archive processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
gather duration of <evaluation cycle> | <time interval> Plural: gather durations | Time taken performing gather processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
gather percent of <evaluation cycle> | <floating point> Plural: gather percents | Percentage of time taken performing gather processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
other duration of <evaluation cycle> | <time interval> Plural: other durations | Time taken performing other (unclassified) processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
other percent of <evaluation cycle> | <floating point> Plural: other percents | Percentage of time taken performing other (unlassified) processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
property duration of <evaluation cycle> | <time interval> Plural: property durations | Time taken performing property processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
property percent of <evaluation cycle> | <floating point> Plural: property percents | Percentage of time taken performing property processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
quiet mode duration of <evaluation cycle> | <time interval> Plural: quiet mode durations | Time taken performing quiet mode processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
quiet mode percent of <evaluation cycle> | <floating point> Plural: quiet mode percents | Percentage of time taken performing quite mode processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
relay select duration of <evaluation cycle> | <time interval> Plural: relay select durations | Time taken performing relay select processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
relay select percent of <evaluation cycle> | <floating point> Plural: relay select percents | Percentage of time taken performing relay select processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
relevance duration of <evaluation cycle> | <time interval> Plural: relevance durations | Time taken performing relevance processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
relevance percent of <evaluation cycle> | <floating point> Plural: relevance percents | Percentage of time taken performing relevance processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
report duration of <evaluation cycle> | <time interval> Plural: report durations | Time taken performing report processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
report percent of <evaluation cycle> | <floating point> Plural: report percents | Percentage of time taken performing report processing since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
sleep duration of <evaluation cycle> | <time interval> Plural: sleep durations | Time taken sleeping since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
sleep percent of <evaluation cycle> | <floating point> Plural: sleep percents | Percentage of time taken sleeping since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
total duration of <evaluation cycle> | <time interval> Plural: total durations | Total time since agent start | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
track fixlet of <evaluation cycle> | <string> Plural: track fixlets | Returns tracking statistics of fixlets with the longest evaluation time. Number of fixlets tracked depends on Tracking settings. Default is top 10 fixlets. | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
average duration of <evaluation cycle> | <time interval> Plural: average durations | Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2 | |
average of <evaluation cycle> | <integer> Plural: averages | Returns the average time, in milliseconds, that it takes to evaluate a given BigFix Client content set. The average is based on the last ten cycles. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
maximum duration of <evaluation cycle> | <time interval> Plural: maximum durations | Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2 | |
maximum of <evaluation cycle> | <integer> Plural: maximums | Returns the maximum time, in milliseconds, that it takes to evaluate a given BigFix Client content set. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
Declaration | Description | Platforms (?) |
application usage summary | Returns an application usage summary containing information including the start time, duration and other statistics on client applications. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
application usage summary <string> | Returns the usage summary for the application specified in <string>. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Declaration | Return type | Description | Platforms (?) |
first start time of <application usage summary> | <time> Plural: first start times | Returns the start time of the specified application since the computer was configured to track it, regardless of reboots. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
instance of <application usage summary> | <application usage summary instance> Plural: instances | Returns a list of all the instances of a specified application usage summary. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
last start time of <application usage summary> | <time> Plural: last start times | Returns the last time this specified application was started. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
last time seen of <application usage summary> | <time> Plural: last times seen | Returns the last time this specified application was seen running. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
name of <application usage summary> | <string> Plural: names | Returns the names of the applications that are currently enabled for usage summaries. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
running of <application usage summary> | <boolean> Plural: runnings | Returns TRUE if the specified application is currently running. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
total duration of <application usage summary> | <time interval> Plural: total durations | Returns the total elapsed time that the specified application has been running. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
total run count of <application usage summary> | <integer> Plural: total run counts | Returns the number of times that the specified application has been run since the client was configured to track it. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Declaration | Description | Platforms (?) |
instance of <application usage summary> | Returns a list of all the instances of a specified application usage summary. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
Declaration | Return type | Description | Platforms (?) |
first start time of <application usage summary instance> | <time> Plural: first start times | Returns the start time of the specified application instance since the computer was configured to track it, regardless of reboots. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
last start time of <application usage summary instance> | <time> Plural: last start times | Returns the last time this specified application was started. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
last time seen of <application usage summary instance> | <time> Plural: last times seen | Returns the last time this specified application was seen running. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
name of <application usage summary instance> | <string> Plural: names | Returns the name(s) of the application instance(s) currently enabled for usage summaries. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
size of <application usage summary instance> | <integer> Plural: sizes | Returns the size of the specified application instance. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
string version of <application usage summary instance> | <string> Plural: string versions | Returns the version of the specified application instance as a string value. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
total duration of <application usage summary instance> | <time interval> Plural: total durations | Returns the total elapsed time that the specified application instance has been running. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
total run count of <application usage summary instance> | <integer> Plural: total run counts | Returns the number of times that the specified application instance has been run since the client was configured to track it. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
version of <application usage summary instance> | <version> Plural: versions | Returns the version of the specified application instance. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |